/*
 *  Copyright (C) 2009  Peter Kist & Jan Ripke
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __mediator_event_h
#define __mediator_event_h 1

#include <mediator/Interface.h>

namespace galaxy {
    namespace mediator {

        /**
        * Contains data that must be transported from producer to consumer.
        * This class is identified by a module identifier that specifies for
        * which (listening) consumer the event is meant.
        */
        class Event : public Identifier
        {
        public:

            Event() { };
            Event(Event& src) : Identifier (src) { };
            /** Constructs an event for the specified category, type and subtype */
            Event(Category category, int type, int subtype) : Identifier (category, type, subtype) { };
            virtual ~Event() { };

            /** Clone the event. 
            * This method needs to be implemented for each specialized Event that adds
            * data to the base.
            */
            virtual Event * clone () { return new Event(); };
            virtual const char * eventType () { return "Event"; };
        };

    } // namespace mediator

} // namespace galaxy

#endif // __mediator_event_h
